Skip to content

docs(collator): include "id" placeholder in start command example#1694

Merged
eshaben merged 3 commits into
polkadot-developers:masterfrom
olahfemi:patch-3
Jun 3, 2026
Merged

docs(collator): include "id" placeholder in start command example#1694
eshaben merged 3 commits into
polkadot-developers:masterfrom
olahfemi:patch-3

Conversation

@olahfemi
Copy link
Copy Markdown
Contributor

@olahfemi olahfemi commented May 31, 2026

📝 Description

Updated the command example for starting the collator to include a placeholder for the "id". This ensures the path is properly created and detected, helping prevent routing and initialisation errors when running the command.

Error if the user doesn't use their "id" in the command:

Screenshot 2026-05-31 at 22 15 54

Test to confirm that the command that starts the collator needs the "id"

Screenshot 2026-05-31 at 22 39 58 You'd see in the screenshot above that, even though the parachain name is Ethereum, the collator still starts since I used the id name in the path. This is because the Polkadot Omni node uses the "id" to create the base path for storing the node key.

🔍 Review Preference

Choose one:

  • ✅ I have time to handle formatting/style feedback myself
  • ⚡ Docs team handles formatting (check "Allow edits from maintainers")

✅ Checklist

Updated the command example for starting the collator to include a placeholder for the "id". This ensures the path is properly created and detected, helping prevent routing and initialisation errors when running the command.
@olahfemi olahfemi requested a review from a team as a code owner May 31, 2026 21:20
@nhussein11 nhussein11 self-requested a review June 1, 2026 15:43
Comment thread parachains/launch-a-parachain/deploy-to-polkadot.md Outdated
Comment thread parachains/launch-a-parachain/deploy-to-polkadot.md Outdated
@eshaben
Copy link
Copy Markdown
Collaborator

eshaben commented Jun 1, 2026

Applied minor formatting changes to adhere to our style guide. @0xlukem can you pls sign off on this?

@eshaben eshaben requested a review from 0xlukem June 1, 2026 17:38
@eshaben eshaben added B0 - Needs Review Pull request is ready for review A3 - Quick Fixes Pull request contains small fixes (i.e., fixing a typo, removing old images, etc.) labels Jun 1, 2026
Copy link
Copy Markdown
Contributor

@0xlukem 0xlukem left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@0xlukem 0xlukem added B1 - Ready to Merge Pull request is ready to be merged and removed B0 - Needs Review Pull request is ready for review labels Jun 3, 2026
@eshaben eshaben merged commit 5443c7e into polkadot-developers:master Jun 3, 2026
12 of 15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A3 - Quick Fixes Pull request contains small fixes (i.e., fixing a typo, removing old images, etc.) B1 - Ready to Merge Pull request is ready to be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants